<!doctype html>
<html lang="en">
<head>
    <title>API for class methodDoc (phpAPI: PHP Documentation Creator version 6.0)</title>
    <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
    <meta name="generator" content="phpAPI 6.0 (https://github.com/Greenray/phpAPI/)">
    <link rel="stylesheet" type="text/css" href="../style.css">
    <link rel="start" href="../index.html">
</head>
    <body id="methodDoc" onload="parent.document.title=document.title;">
    <div class="header">
    <span style="float:right">phpAPI v6.0</span>
            <ul>
                    <li><a href="../overview-summary.html">Overview</a></li>
                    <li><a href="../phpapi/package-summary.html">Namespace</a></li>
                    <li class="active">Class</li>
                    <li><a href="../phpapi/package-tree.html">phpapi\Tree</a></li>
                    <li><a href="../deprecated.html">Deprecated</a></li>
                    <li><a href="../todo.html">Todo</a></li>
                    <li><a href="../index-all.html">Index</a></li>
                </ul>
    </div>
<hr />
<div class="small_links">Frames: <a href="../index.html" target="_top"> On</a> | <a href="" target="_top"> Off</a></div>
<hr />
    <div class="small_links">
        <a href="#details_fields">Fields</a> | <a href="#details_methods">Methods</a> | <a href="#details_constructor">Constructor</a>
    </div>
    <hr />
<div class="package">Namespace phpapi</div>
<h1>Class methodDoc</h1>
<div id="list">
    <ul>
        <li><a href="../phpapi/doc.html">doc</a><ul><li><a href="../phpapi/elementdoc.html">elementDoc</a><ul><li><strong>methodDoc</strong></li></ul></li>
                        </ul></li>    </ul>
</div>
<hr />
<p class="arguments">public  class <strong>methodDoc</strong> extends <a href="../phpapi/elementdoc.html">elementDoc</a></p>
<div class="comment" id="overview_description">Represents a PHP function or method (member function).</div>
<div class="finfo">
    <table class="hid">
            <tr>
            <td class="hid left w_100">Program</td>
            <td class="hid right w_100 lilac">&nbsp;</td>
                            <td class="hid" colspan="2">phpapi: PHP Documentation Creator</td>
                    </tr>
            <tr>
            <td class="hid left w_100">Version</td>
            <td class="hid right w_100 lilac">&nbsp;</td>
                            <td class="hid" colspan="2">6.0</td>
                    </tr>
            <tr>
            <td class="hid left w_100">Author</td>
            <td class="hid right w_100 lilac">&nbsp;</td>
                            <td class="hid" colspan="2">Victor Nabatov greenray.spb@gmail.com</td>
                    </tr>
            <tr>
            <td class="hid left w_100">Copyright</td>
            <td class="hid right w_100 lilac">&nbsp;</td>
                            <td class="hid" colspan="2">(c) 2015-2016 Victor Nabatov</td>
                    </tr>
            <tr>
            <td class="hid left w_100">License</td>
            <td class="hid right w_100 lilac">&nbsp;</td>
                            <td class="hid" colspan="2">Creative Commons Attribution-ShareAlike 4.0 International</td>
                    </tr>
            <tr>
            <td class="hid left w_100">File</td>
            <td class="hid right w_100 lilac">&nbsp;</td>
                            <td class="hid" colspan="2">/system/classes/methodDoc.php</td>
                    </tr>
        </table>
</div>
            <table class="inherit">
            <tr><th>Fields inherited from phpapi \ elementDoc</th></tr>
            <tr>
                <td>
                                    <span><a href="../phpapi/elementdoc.html#$access"><span class="green">$access, </span></a>&nbsp;</span>
                                    <span><a href="../phpapi/elementdoc.html#$filename"><span class="green">$filename, </span></a>&nbsp;</span>
                                    <span><a href="../phpapi/elementdoc.html#$final"><span class="green">$final, </span></a>&nbsp;</span>
                                    <span><a href="../phpapi/elementdoc.html#$includes"><span class="green">$includes, </span></a>&nbsp;</span>
                                    <span><a href="../phpapi/elementdoc.html#$lineNumber"><span class="green">$lineNumber, </span></a>&nbsp;</span>
                                    <span><a href="../phpapi/elementdoc.html#$package"><span class="green">$package, </span></a>&nbsp;</span>
                                    <span><a href="../phpapi/elementdoc.html#$parameters"><span class="green">$parameters, </span></a>&nbsp;</span>
                                    <span><a href="../phpapi/elementdoc.html#$parent"><span class="green">$parent, </span></a>&nbsp;</span>
                                    <span><a href="../phpapi/elementdoc.html#$sourcePath"><span class="green">$sourcePath, </span></a>&nbsp;</span>
                                    <span><a href="../phpapi/elementdoc.html#$static"><span class="green">$static, </span></a>&nbsp;</span>
                                    <span><a href="../phpapi/elementdoc.html#$throws"><span class="green">$throws</span></a>&nbsp;</span>
                                </td>
            </tr>
        </table>
            <table class="inherit">
            <tr><th>Fields inherited from phpapi \ doc</th></tr>
            <tr>
                <td>
                                    <span><a href="../phpapi/doc.html#$data"><span class="green">$data, </span></a>&nbsp;</span>
                                    <span><a href="../phpapi/doc.html#$desc"><span class="green">$desc, </span></a>&nbsp;</span>
                                    <span><a href="../phpapi/doc.html#$docComment"><span class="green">$docComment, </span></a>&nbsp;</span>
                                    <span><a href="../phpapi/doc.html#$inBody"><span class="green">$inBody, </span></a>&nbsp;</span>
                                    <span><a href="../phpapi/doc.html#$name"><span class="green">$name, </span></a>&nbsp;</span>
                                    <span><a href="../phpapi/doc.html#$overview"><span class="green">$overview, </span></a>&nbsp;</span>
                                    <span><a href="../phpapi/doc.html#$root"><span class="green">$root, </span></a>&nbsp;</span>
                                    <span><a href="../phpapi/doc.html#$tags"><span class="green">$tags</span></a>&nbsp;</span>
                                </td>
            </tr>
        </table>
                <table class="inherit">
            <tr><th>Methods inherited from phpapi \ elementDoc</th></tr>
            <tr>
                <td>
                                    <span><a href="../phpapi/elementdoc.html#construct">construct, </a>&nbsp;</span>
                                    <span><a href="../phpapi/elementdoc.html#arguments">arguments, </a>&nbsp;</span>
                                    <span><a href="../phpapi/elementdoc.html#containingClass">containingClass, </a>&nbsp;</span>
                                    <span><a href="../phpapi/elementdoc.html#containingPackage">containingPackage, </a>&nbsp;</span>
                                    <span><a href="../phpapi/elementdoc.html#fullNamespace">fullNamespace, </a>&nbsp;</span>
                                    <span><a href="../phpapi/elementdoc.html#location">location, </a>&nbsp;</span>
                                    <span><a href="../phpapi/elementdoc.html#modifiers">modifiers, </a>&nbsp;</span>
                                    <span><a href="../phpapi/elementdoc.html#path">path</a>&nbsp;</span>
                                </td>
            </tr>
        </table>
            <table class="inherit">
            <tr><th>Methods inherited from phpapi \ doc</th></tr>
            <tr>
                <td>
                                    <span><a href="../phpapi/doc.html#construct">construct, </a>&nbsp;</span>
                                    <span><a href="../phpapi/doc.html#isClass">isClass, </a>&nbsp;</span>
                                    <span><a href="../phpapi/doc.html#isConstructor">isConstructor, </a>&nbsp;</span>
                                    <span><a href="../phpapi/doc.html#isException">isException, </a>&nbsp;</span>
                                    <span><a href="../phpapi/doc.html#isField">isField, </a>&nbsp;</span>
                                    <span><a href="../phpapi/doc.html#isFunction">isFunction, </a>&nbsp;</span>
                                    <span><a href="../phpapi/doc.html#isGlobal">isGlobal, </a>&nbsp;</span>
                                    <span><a href="../phpapi/doc.html#isInterface">isInterface, </a>&nbsp;</span>
                                    <span><a href="../phpapi/doc.html#isMethod">isMethod, </a>&nbsp;</span>
                                    <span><a href="../phpapi/doc.html#isOrdinaryClass">isOrdinaryClass, </a>&nbsp;</span>
                                    <span><a href="../phpapi/doc.html#isTrait">isTrait, </a>&nbsp;</span>
                                    <span><a href="../phpapi/doc.html#mergeData">mergeData, </a>&nbsp;</span>
                                    <span><a href="../phpapi/doc.html#set">set, </a>&nbsp;</span>
                                    <span><a href="../phpapi/doc.html#setByRef">setByRef</a>&nbsp;</span>
                                </td>
            </tr>
        </table>
        <h2 id="details_fields">Fields</h2>
            <div class="location">system/classes/methodDoc.php at line 17</div>
        <pre class="arguments" id="abstract">public  boolean <strong><span class="green">$abstract</span></strong> = FALSE;</pre>
        <div class="details">Is this method abstract</div>
        <hr />
            <div class="location">system/classes/methodDoc.php at line 20</div>
        <pre class="arguments" id="includes">public  array <strong><span class="green">$includes</span></strong> = [];</pre>
        <div class="details">Required files or files to be included</div>
        <hr />
            <div class="location">system/classes/methodDoc.php at line 23</div>
        <pre class="arguments" id="returnType">public  <a href="../phpapi/type.html">type</a> <strong><span class="green">$returnType</span></strong></pre>
        <div class="details">Type of returns variable</div>
        <hr />
        <h2 id="details_constructor">Constructor</h2>
    <div class="location">system/classes/methodDoc.php at line 35</div>
    <code class="arguments" id="construct">public  void <strong>construct</strong>(<span class="lilac">string</span> <span class="blue">$name</span>, <span class="lilac">classDoc|methodDoc</span> <span class="blue">&$parent</span>, <a href="../phpapi/rootdoc.html">rootDoc</a> <span class="blue">&$root</span>, <span class="lilac">string</span> <span class="blue">$filename</span>, <span class="lilac">integer</span> <span class="blue">$lineNumber</span>, <span class="lilac">string</span> <span class="blue">$sourcePath</span>)</code>
    <div class="details">
            <p class="description">Constructor.</p>
        <div class="finfo">
    <table class="hid">
            <tr>
            <td class="hid left w_100">Parameters</td>
            <td class="hid right w_100 lilac">string</td>
                            <td class="hid blue w_100">$name</td>
                <td class="hid">Name of this element</td>
                    </tr>
            <tr>
            <td class="hid left w_100">&nbsp</td>
            <td class="hid right w_100 lilac">classDoc|methodDoc</td>
                            <td class="hid blue w_100">&$parent</td>
                <td class="hid">Reference to the parent of this element</td>
                    </tr>
            <tr>
            <td class="hid left w_100">&nbsp</td>
            <td class="hid right w_100 lilac"><a href="../phpapi/rootdoc.html">rootDoc</a></td>
                            <td class="hid blue w_100">&$root</td>
                <td class="hid">Reference to the root element</td>
                    </tr>
            <tr>
            <td class="hid left w_100">&nbsp</td>
            <td class="hid right w_100 lilac">string</td>
                            <td class="hid blue w_100">$filename</td>
                <td class="hid">Filename of the source file this element is in</td>
                    </tr>
            <tr>
            <td class="hid left w_100">&nbsp</td>
            <td class="hid right w_100 lilac">integer</td>
                            <td class="hid blue w_100">$lineNumber</td>
                <td class="hid">Line number of the source file this element is at</td>
                    </tr>
            <tr>
            <td class="hid left w_100">&nbsp</td>
            <td class="hid right w_100 lilac">string</td>
                            <td class="hid blue w_100">$sourcePath</td>
                <td class="hid">Source path containing the source file</td>
                    </tr>
        </table>
</div>
    </div>
    <h2 id="details_methods">Methods</h2>
            <div class="location">system/classes/methodDoc.php at line 50</div>
        <code class="arguments" id="isConstructor">public  boolean <strong>isConstructor</strong> ()</code>
        <div class="details">
                    <p class="description">Returns TRUE if this class is an constructor.</p>
                    </div>
        <hr />
            <div class="location">system/classes/methodDoc.php at line 59</div>
        <code class="arguments" id="isDestructor">public  boolean <strong>isDestructor</strong> ()</code>
        <div class="details">
                    <p class="description">Returns TRUE if this class is an destructor.</p>
                    </div>
        <hr />
            <div class="location">system/classes/methodDoc.php at line 68</div>
        <code class="arguments" id="isFunction">public  boolean <strong>isFunction</strong> ()</code>
        <div class="details">
                    <p class="description">Is this construct a function.</p>
                    </div>
        <hr />
            <div class="location">system/classes/methodDoc.php at line 78</div>
        <code class="arguments" id="isMethod">public  boolean <strong>isMethod</strong> ()</code>
        <div class="details">
                    <p class="description">Constructs a method.<br /> False until overridden.</p>
                    </div>
        <hr />
            <div class="location">system/classes/methodDoc.php at line 88</div>
        <code class="arguments" id="returnType">public  string <strong>returnType</strong> ()</code>
        <div class="details">
                    <p class="description">Formats a return type for outputting.<br /> Recognised types are turned into HTML anchor tags to the documentation page for the class defining them.</p>
                    </div>
        <hr />
        <div class="header">
    <span style="float:right">phpAPI v6.0</span>
            <ul>
                    <li><a href="../overview-summary.html">Overview</a></li>
                    <li><a href="../phpapi/package-summary.html">Namespace</a></li>
                    <li class="active">Class</li>
                    <li><a href="../phpapi/package-tree.html">phpapi\Tree</a></li>
                    <li><a href="../deprecated.html">Deprecated</a></li>
                    <li><a href="../todo.html">Todo</a></li>
                    <li><a href="../index-all.html">Index</a></li>
                </ul>
    </div>
<hr />
<div class="small_links">Frames: <a href="../index.html" target="_top"> On</a> | <a href="" target="_top"> Off</a></div>
<hr />
    <div class="small_links">
        <a href="#details_fields">Fields</a> | <a href="#details_methods">Methods</a> | <a href="#details_constructor">Constructor</a>
    </div>
    </body>
</html>
